<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xilskey: xilskey_puf_registration_example.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xilskey
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xilskey__puf__registration__example_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xilskey_puf_registration_example.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file illustrates how to do PUF registration and generating syndrome data and obtaining helper data, debug 2 result, Auxiliary and CHash values from generated syndrome data. </p>
<p>This example also encrypts the provided AES key with PUF and generates the black key. Finally programs the PUF code and black key into eFUSE on user request (provided in <a class="el" href="xilskey__puf__registration_8h.html" title="This file contains header interface related information for PUF device and macros used in the driver...">xilskey_puf_registration.h</a>)</p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who   Date     Changes
----- ---  -------- -------------------------------------------------------
6.1   rp   17/10/16 First release.
6.2   vns  02/18/17 Modified Encrypt API call due to change in Xilsecure
           03/10/17 Added Support for programming and reading PUF reserved
                    bit
6.7   mmd  03/17/19 Ignored PUF data on overflow
6.9   kpt  02/27/20 Removed XilSKey_Puf_Fetch_Dbg_Mode2_result
                    which is used only for debug purpose
      har  03/09/20 Fixed array overrun condition in
                    XilSKey_Generate_FuseFormat function.
      kal  05/15/20 Replace all eFuse read with Cache reads.
7.0   kpt  09/02/20 Added successfully ran print to the example in case of
                    success</pre><pre></pre><dl class="section note"><dt>Note</dt><dd></dd></dl>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xilskey__puf__registration__example_8c.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a> ()</td></tr>
<tr class="separator:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ae66f6b31b5ad750f1fe042a706a4e3d4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int main </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>TBD: Move the Status code to the persistent register</p>

<p>References <a class="el" href="group__xilskey__zynqmp__efuse.html#ga4f7dae2403511abb09eb0504751f35f4">XilSKey_Puf_Registration()</a>, <a class="el" href="group__xilskey__zynqmp__efuse.html#ga64b5db9c2f22e5e5092d58ac7ad4d7f9">XilSKey_Read_Puf_EfusePs_SecureBits()</a>, <a class="el" href="group__xilskey__zynqmp__efuse.html#ga9491848827417a1fb9e25947487e27bf">XilSKey_Write_Puf_EfusePs_SecureBits()</a>, <a class="el" href="group__xilskey__zynqmp__efuse.html#gad1be2e29f7eba2e556ac69870cd2e028">XilSKey_ZynqMp_EfusePs_ReadPufAux()</a>, <a class="el" href="group__xilskey__zynqmp__efuse.html#gaea3d5e3e09a52ed2a9a3027c065cca23">XilSKey_ZynqMp_EfusePs_ReadPufChash()</a>, <a class="el" href="group__xilskey__zynqmp__efuse.html#ga244ec0ae43d34ee6500c06dd91f9d372">XilSKey_ZynqMp_EfusePs_ReadPufHelprData()</a>, <a class="el" href="group__xilskey__zynqmp__efuse.html#gafe8ae7aba73e1e4b667aed0bad8f64aa">XilSKey_ZynqMp_EfusePs_ReadSecCtrlBits()</a>, <a class="el" href="group__xilskey__zynqmp__efuse.html#ga67de13526ea1502e25b09f80094f2246">XilSKey_ZynqMp_EfusePs_WritePufAux()</a>, <a class="el" href="group__xilskey__zynqmp__efuse.html#gaf1587f5d17256fdbca55efa1cc0eeac0">XilSKey_ZynqMp_EfusePs_WritePufChash()</a>, <a class="el" href="group__xilskey__zynqmp__efuse.html#ga5b392432af864665cf95a540ab576388">XilSKey_ZynqMp_EfusePs_WritePufHelprData()</a>, <a class="el" href="group__xilskey__psefuse__error__codes.html#gga35d67e0a9db73e1fa64262f5eb8f9d6aac840ba4043d600d19b7699544a2f461f">XSK_EFUSEPS_ERROR_PUF_DATA_OVERFLOW</a>, and <a class="el" href="xilskey__puf__registration_8h.html#a98db935ff1ae5bab36372b82a95c68d9">XSK_PUF_REG_MODE</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
